
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>particle_size_models.ModelBase &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="particle_size_models.ModelBase.get_d50" href="particle_size_models.ModelBase.get_d50.html" />
    <link rel="prev" title="Overview of Particle Size Models Module" href="../../modules/particle_size_models.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="particle-size-models-modelbase">
<h1>particle_size_models.ModelBase<a class="headerlink" href="#particle-size-models-modelbase" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="particle_size_models.ModelBase">
<em class="property">class </em><code class="sig-prename descclassname">particle_size_models.</code><code class="sig-name descname">ModelBase</code><span class="sig-paren">(</span><em class="sig-param">rho_gas</em>, <em class="sig-param">mu_gas</em>, <em class="sig-param">sigma_gas</em>, <em class="sig-param">rho_oil</em>, <em class="sig-param">mu_oil</em>, <em class="sig-param">sigma_oil</em>, <em class="sig-param">rho</em>, <em class="sig-param">mu</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/particle_size_models.html#ModelBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#particle_size_models.ModelBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Master class object for interfacing with functions in the <cite>psf</cite> module</p>
<p>This base model class contains the attributes necessary to directly call
the functions in the <cite>psf</cite> module.  This class is also initialized with
these fluid properties; hence, this class can be used independently of
<code class="docutils literal notranslate"><span class="pre">TAMOC</span></code> or the discrete particle module (<cite>dbm</cite>) in TAMOC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>rho_gas</strong><span class="classifier">float</span></dt><dd><p>Density of the gas phase released from the jet (kg/m^3)</p>
</dd>
<dt><strong>mu_gas</strong><span class="classifier">float</span></dt><dd><p>Dynamic viscosity of the gas phase released from the jet (Pa s)</p>
</dd>
<dt><strong>sigma_gas</strong><span class="classifier">float</span></dt><dd><p>Interfacial tension between the gas phase released from the jet and
the continuous-phase receiving fluid (N/m)</p>
</dd>
<dt><strong>rho_oil</strong><span class="classifier">float</span></dt><dd><p>Density of the liquid phase released from the jet (kg/m^3)</p>
</dd>
<dt><strong>mu_oil</strong><span class="classifier">float</span></dt><dd><p>Dynamic viscosity of the liquid phase released from the jet (Pa s)</p>
</dd>
<dt><strong>sigma_oil</strong><span class="classifier">float</span></dt><dd><p>Interfacial tension between the liquid phase released from the jet
and the continuous-phase receiving fluid (N/m)</p>
</dd>
<dt><strong>rho</strong><span class="classifier">float</span></dt><dd><p>Density of the continuous-phase receiving fluid (kg/m^3)</p>
</dd>
<dt><strong>mu</strong><span class="classifier">float</span></dt><dd><p>Dynamic viscosity of the continuous-phase receiving fluid (Pa s)</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="particle_size_models.PureJet.html#particle_size_models.PureJet" title="particle_size_models.PureJet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PureJet</span></code></a>, <a class="reference internal" href="particle_size_models.Model.html#particle_size_models.Model" title="particle_size_models.Model"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Model</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>This class should only be used is the chemical properties are not going
to be computed using the <code class="docutils literal notranslate"><span class="pre">TAMOC</span></code> <cite>dbm</cite>.  If the <cite>dbm</cite> is going to be
used, then the regular <cite>Model</cite> class should be used instead.</p>
<dl class="field-list simple">
<dt class="field-odd">Attributes</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>rho_gas</strong><span class="classifier">float</span></dt><dd><p>Density of the gas phase released from the jet (kg/m^3)</p>
</dd>
<dt><strong>mu_gas</strong><span class="classifier">float</span></dt><dd><p>Dynamic viscosity of the gas phase released from the jet (Pa s)</p>
</dd>
<dt><strong>sigma_gas</strong><span class="classifier">float</span></dt><dd><p>Interfacial tension between the gas phase released from the jet and
the continuous-phase receiving fluid (N/m)</p>
</dd>
<dt><strong>rho_oil</strong><span class="classifier">float</span></dt><dd><p>Density of the liquid phase released from the jet (kg/m^3)</p>
</dd>
<dt><strong>mu_oil</strong><span class="classifier">float</span></dt><dd><p>Dynamic viscosity of the liquid phase released from the jet (Pa s)</p>
</dd>
<dt><strong>sigma_oil</strong><span class="classifier">float</span></dt><dd><p>Interfacial tension between the liquid phase released from the jet
and the continuous-phase receiving fluid (N/m)</p>
</dd>
<dt><strong>rho</strong><span class="classifier">float</span></dt><dd><p>Density of the continuous-phase receiving fluid (kg/m^3)</p>
</dd>
<dt><strong>mu</strong><span class="classifier">float</span></dt><dd><p>Dynamic viscosity of the continuous-phase receiving fluid (Pa s)</p>
</dd>
<dt><strong>sim_stored</strong><span class="classifier">bool</span></dt><dd><p>Flag indicating whether or not the particle size distribution
algorithm has been calculated since the last property update.</p>
</dd>
<dt><strong>distribution_stored</strong><span class="classifier">bool</span></dt><dd><p>Flag indicating whether or not the particle size distribution has
been computed and stored since the last property update.</p>
</dd>
<dt><strong>d0</strong><span class="classifier">float</span></dt><dd><p>Equivalent circular diameter of the release orifice (m)</p>
</dd>
<dt><strong>m_gas</strong><span class="classifier">float</span></dt><dd><p>Mass flow rate of gas released from the jet (kg/s)</p>
</dd>
<dt><strong>m_oil</strong><span class="classifier">float</span></dt><dd><p>Mass flow rate of liquid released from the jet (kg/s)</p>
</dd>
<dt><strong>model_gas</strong><span class="classifier">str</span></dt><dd><p>Name of the model used for computing the gas bubble size
distribution.  Choices are ‘wang_etal’ or ‘li_etal’:.</p>
</dd>
<dt><strong>model_oil</strong><span class="classifier">str</span></dt><dd><p>Name of the model used for computing the oil droplet size
distribution.  Choices are ‘sintef’ or ‘li_etal’.</p>
</dd>
<dt><strong>pdf_gas</strong><span class="classifier">str</span></dt><dd><p>Probability density function to use for the gas bubble size
distribution.  Choices are ‘lognormal’ or ‘rosin-rammler’.</p>
</dd>
<dt><strong>pdf_oil</strong><span class="classifier">str</span></dt><dd><p>Probability density function to use for the oil droplet size
distribution.  Choices are ‘lognormal’ or ‘rosin-rammler’.</p>
</dd>
<dt><strong>d50_gas</strong><span class="classifier">float</span></dt><dd><p>Median equivalent spherical diameter of gas bubbles (m)</p>
</dd>
<dt><strong>de_max_gas</strong><span class="classifier">float</span></dt><dd><p>Maximum stable bubble size (equivalent spherical diameter) of gas
bubbles (m).</p>
</dd>
<dt><strong>de_gas</strong><span class="classifier">ndarray</span></dt><dd><p>Array of equivalent spherical diameters of bubbles in the bubble
size distribution (log-distributed, m)</p>
</dd>
<dt><strong>vf_gas</strong><span class="classifier">ndarray</span></dt><dd><p>Array of volume fractions of gas corresponding to each bubble size
in the  <cite>de_gas</cite> bubble size distribution (–)</p>
</dd>
<dt><strong>d50_oil</strong><span class="classifier">float</span></dt><dd><p>Median equivalent spherical diameter of oil droplets (m)</p>
</dd>
<dt><strong>de_max_oil</strong><span class="classifier">float</span></dt><dd><p>Maximum stable droplet size (equivalent spherical diameter) of oil
droplets (m).</p>
</dd>
<dt><strong>de_oil</strong><span class="classifier">ndarray</span></dt><dd><p>Array of equivalent spherical diameters of droplets in the droplet
size distribution (log-distributed, m)</p>
</dd>
<dt><strong>vf_oil</strong><span class="classifier">ndarray</span></dt><dd><p>Array of volume fractions of oil corresponding to each droplet size
in the  <cite>de_oil</cite> droplet size distribution (–)</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Methods</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="particle_size_models.ModelBase.get_d50.html#particle_size_models.ModelBase.get_d50" title="particle_size_models.ModelBase.get_d50"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_d50</span></code></a>(self, fp_type)</p></td>
<td><p>Report the median particle size of a fluid at the release</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="particle_size_models.ModelBase.get_de_max.html#particle_size_models.ModelBase.get_de_max" title="particle_size_models.ModelBase.get_de_max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_de_max</span></code></a>(self, fp_type)</p></td>
<td><p>Report the maximum stable particle size of a fluid at the release</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="particle_size_models.ModelBase.get_distributions.html#particle_size_models.ModelBase.get_distributions" title="particle_size_models.ModelBase.get_distributions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_distributions</span></code></a>(self, nbins_gas, nbins_oil)</p></td>
<td><p>Report the bubble and droplet size distributions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="particle_size_models.ModelBase.plot_psd.html#particle_size_models.ModelBase.plot_psd" title="particle_size_models.ModelBase.plot_psd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_psd</span></code></a>(self[, fig, fp_type])</p></td>
<td><p>Create plots of the bubble and droplet size distribution</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="particle_size_models.ModelBase.simulate.html#particle_size_models.ModelBase.simulate" title="particle_size_models.ModelBase.simulate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">simulate</span></code></a>(self, d0, m_gas, m_oil[, …])</p></td>
<td><p>Compute the parameters of the particle size distribution</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="particle_size_models.ModelBase.update_properties.html#particle_size_models.ModelBase.update_properties" title="particle_size_models.ModelBase.update_properties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_properties</span></code></a>(self, rho_gas, mu_gas, …)</p></td>
<td><p>Set the thermodynamic properties of the released and receiving fluids</p></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="particle_size_models.ModelBase.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">rho_gas</em>, <em class="sig-param">mu_gas</em>, <em class="sig-param">sigma_gas</em>, <em class="sig-param">rho_oil</em>, <em class="sig-param">mu_oil</em>, <em class="sig-param">sigma_oil</em>, <em class="sig-param">rho</em>, <em class="sig-param">mu</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/particle_size_models.html#ModelBase.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#particle_size_models.ModelBase.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self.  See help(type(self)) for accurate signature.</p>
</dd></dl>

<p class="rubric">Methods</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#particle_size_models.ModelBase.__init__" title="particle_size_models.ModelBase.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(self, rho_gas, mu_gas, sigma_gas, …)</p></td>
<td><p>Initialize self.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="particle_size_models.ModelBase.get_d50.html#particle_size_models.ModelBase.get_d50" title="particle_size_models.ModelBase.get_d50"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_d50</span></code></a>(self, fp_type)</p></td>
<td><p>Report the median particle size of a fluid at the release</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="particle_size_models.ModelBase.get_de_max.html#particle_size_models.ModelBase.get_de_max" title="particle_size_models.ModelBase.get_de_max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_de_max</span></code></a>(self, fp_type)</p></td>
<td><p>Report the maximum stable particle size of a fluid at the release</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="particle_size_models.ModelBase.get_distributions.html#particle_size_models.ModelBase.get_distributions" title="particle_size_models.ModelBase.get_distributions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_distributions</span></code></a>(self, nbins_gas, nbins_oil)</p></td>
<td><p>Report the bubble and droplet size distributions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="particle_size_models.ModelBase.plot_psd.html#particle_size_models.ModelBase.plot_psd" title="particle_size_models.ModelBase.plot_psd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_psd</span></code></a>(self[, fig, fp_type])</p></td>
<td><p>Create plots of the bubble and droplet size distribution</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="particle_size_models.ModelBase.simulate.html#particle_size_models.ModelBase.simulate" title="particle_size_models.ModelBase.simulate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">simulate</span></code></a>(self, d0, m_gas, m_oil[, …])</p></td>
<td><p>Compute the parameters of the particle size distribution</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="particle_size_models.ModelBase.update_properties.html#particle_size_models.ModelBase.update_properties" title="particle_size_models.ModelBase.update_properties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_properties</span></code></a>(self, rho_gas, mu_gas, …)</p></td>
<td><p>Set the thermodynamic properties of the released and receiving fluids</p></td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/particle_size_models.html">Overview of Particle Size Models Module</a><ul>
      <li>Previous: <a href="../../modules/particle_size_models.html" title="previous chapter">Overview of Particle Size Models Module</a></li>
      <li>Next: <a href="particle_size_models.ModelBase.get_d50.html" title="next chapter">particle_size_models.ModelBase.get_d50</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/psd/particle_size_models.ModelBase.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>